home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / telecomm / stadel / stadel2.zoo / document / manager.doc < prev    next >
Encoding:
Text File  |  1989-08-11  |  18.1 KB  |  461 lines

  1.                        Things that a Sysop should
  2.                         know about running STadel
  3.  
  4.  
  5. 1) SYSOP FUNCTIONS INSIDE CITADEL
  6.  
  7.     STadel can be thought of as having 3 levels to it:  the Peon 
  8.     level (normal users), the Aide level (people with special
  9.     privileges), and the Sysop level.  They are differentiated, of
  10.     course, by what they can do to a STadel system.  
  11.  
  12.     What normal users can do is decided by the Sysop's policy 
  13.     decisions in CTDLCNFG.SYS.  
  14.  
  15.     Aides have 4 commands available to them that is not available to 
  16.     the normal users.  These are accessed thru the command ".Aide
  17.     <cmd>", and they are:  
  18.  
  19. -------------------------------
  20.     [D]elete empty rooms
  21.     [E]dit current room
  22.     [I]nsert pulled message
  23.     [K]ill current room
  24. -------------------------------
  25.  
  26.  
  27.     These are detailed in AIDE.HLP.  Details on how to make a normal 
  28.     user into an aide and vice versa are below.  Aide functions may be
  29.     used from either a remote location or from the system console.  
  30.  
  31.     The Sysop(s)' functions differ from the Aide functions in that 
  32.     they may be used ONLY from the System Console, and in that the
  33.     Sysop does NOT have to be logged in if s/he does not wish to be to
  34.     perform these special functions.  In fact, somebody else can be
  35.     logged in.  
  36.  
  37.     To perform Sysop functions, first ensure that STadel is in 
  38.     CONSOLE mode.  If you are in MODEM mode, hit the ESC.  If somebody
  39.     is on from remote, interrupt him/her only at the room prompts.
  40.     Once in CONSOLE mode, push a CTRL L (control key and L key
  41.     simultaneously);  STadel should then print 'privileged cmd:  ' or
  42.     somesuch.  You now have access to Sysop special functions.  
  43.  
  44.     With the exception of [S]et date below, none of these are 
  45.     accessible to the Aides or anyone else.  
  46.  
  47. -------------------------------
  48.       [B]aud selection.
  49.       [C]hat toggle.
  50.       [D]- Toggle debug mode.
  51.       [E]- Toggle screen echo.
  52.       [F]ile grab.
  53.       [I]nformation.
  54.       [K]ill account.
  55.       [M]ODEM mode.
  56.       [N]etwork commands.
  57.       [O]utside commands.
  58.       [P]- Toggle aide privileges.
  59.       [Q]uit citadel.
  60.       [R]einitialize Modem.
  61.       [S]et date.
  62.       [T]elephone call.
  63.      e[X]it sysop menu.
  64.       [Y]- Show time til next event.
  65.       [Z]- Autodial.
  66. -------------------------------
  67.  
  68.         [A]bort or e[X]it are one (of 3) way out of the Sysop command 
  69.     menu.  Abort puts you back into -CONSOLE- mode.  
  70.  
  71.         The [C]hat switch is a toggle switch that will either tell
  72.     users that you are not around, or will ring the Console's bell to
  73.     call you.  
  74.  
  75.         The [D]ebug switch is for use when debugging STadel.  It's of 
  76.     no use for normal STadel installations.  
  77.  
  78.         To destroy a person's account on a STadel system, use the
  79.     [K]ill Account command.  You will be asked for a name;  if STadel
  80.     finds a user by that name, then it'll ask for confirmation.  
  81.  
  82.         [M]odem mode is the second way to exit the Sysop command menu.
  83.     It leaves STadel in -MODEM- mode.  
  84.  
  85.         The [P]rivilege switch is how you assign and take away Aide 
  86.     privileges from people.  STadel, when this option is selected,
  87.     will ask for a name.  If it finds who you specify, it will print
  88.     out what toggling this person's aide switch will do, and then ask
  89.     you to confirm if that's what you want to do with that person.  
  90.  
  91.         [S]et date allows you to set the date and time.  This data
  92.     will be used to set the system clock.  
  93.  
  94.         The [T]elephone command is a way to use STadel as a modem 
  95.     program -- it will ask you for a system name and if it finds that 
  96.     system name on your network list it will call it and drop into
  97.     Chat mode.  
  98.  
  99.         [Q]uit is the 3rd and last way to exit the Sysop cmd menu.
  100.     This folds STadel up and returns you to the operating system.  
  101.  
  102.         [Z] puts you into a autodialer.  When you type [Z], STadel
  103.     will ask you for a list of systems to call (terminated with a
  104.     blank line) and then the number of times to redial each system.
  105.     After this, it will loop through the list of systems until you
  106.     type any key to abort the callout or until it connects with one.
  107.     If it connects with one, it will beep at you and drop into chat
  108.     mode.  
  109.  
  110.  
  111.  
  112. 2) ARCHIVING ROOMS
  113.  
  114.     An interest has been expressed recently in giving Citadel the 
  115.     ability to automatically maintain, in some way, a record of 
  116.     conversations that are held.  This has been motivated by the 
  117.     CitaBook project, story-telling, and other subjects that have, for
  118.     one reason or another, given the system operator reason to pause, 
  119.     think, and wish to save those messages in a far more permanent
  120.     form than as a Citadel message, which will inevitably scroll.  
  121.  
  122.     Therefore, Citadel now has the ability to maintain just such a 
  123.     textfile on disk.  Called (for the time being) the Archive
  124.     feature, it allows the sysop to designate virtually any room to be
  125.     an Archive room.  Such a room then will have a filename associated
  126.     with it.  Within the file of that name, each and every message
  127.     that is entered into that room will also be appended to a archive
  128.     file.  
  129.  
  130. 2.1) PROCEDURE
  131.  
  132.     The procedure to designate a room as Archive is to simply edit 
  133.     the room (note that this automatically excludes Aide>, Mail>, and 
  134.     the baseRoom as Archive rooms).  One of the questions that you
  135.     will encounter will concern Archive status of the room.  If you
  136.     answer yes, the system will do one of two things:  
  137.  
  138.     A) If the room was not an Archive room before, it'll ask for a 
  139.     filename to associate with the room.  
  140.     B) If it was already an Archive room, it'll just assume that the 
  141.     filename should remain the same, and not bother you further about 
  142.     Archive stuff.  
  143.  
  144.     If it does ask for filename, the filename that you should type in
  145.     can be located anywhere in the system that you desire.  Once you 
  146.     have typed it in, Citadel will attempt to archive all the messages
  147.     that are currently in the room (message numbers will be spewed out
  148.     at this point to reassure you that there is* method in Citadel's 
  149.     madness).  
  150.  
  151.     An Archive room puts each new message into the Archive file when 
  152.     it is initially entered into the room (note that Aide actions,
  153.     such as deleting the message later, does not affect the Archive
  154.     file).  
  155.  
  156. 2.2) CONSIDERATIONS
  157.  
  158.     This feature is recommended only for high-performance systems, 
  159.     particularly those with fairly fast hard disks, since each message
  160.     is, in effect, saved twice.  Furthermore, since active rooms will 
  161.     result in very fast file growth, close tabs should be kept on disk
  162.     free space by the sysop.  
  163.  
  164. 2.3) NOTES
  165.  
  166.     This is all Torkildson's fault.  
  167.     The filenames are stored in the new .SYS file CTDLARCH.SYS file.  
  168.     This file is unique in the respect that it is a human readable
  169.     text file.  Each Archive room on the system will have an entry in
  170.     this file, in the following format:  
  171.  
  172.     <room#><space><full-filespec>
  173.  
  174.     Thus, if the sysop wants to modify what file to store the Archive
  175.     data in without going through the hassle of editing the room 
  176.     twice (see above), s/he can whip out their handy-dandy text
  177.     editor, and fix it right then and there.  
  178.  
  179.  
  180. 3) ARCHIVING MAIL
  181.  
  182.     The sysop may archive his mail to disk by using the #archive-mail 
  183.     command in ctdlcnfg.sys.  If you set #archive-mail "person", all
  184.     mail to and from "person" will be archived to the file sysop.msg
  185.     in your #auditdir.  
  186.  
  187.  
  188. 4) FILE DESCRIPTIONS (FILE TAGS)
  189.  
  190.     File tagging is the ability to associate a short text description 
  191.     with a file, which can be displayed on command, along with the
  192.     file names.  
  193.  
  194.     STadel will now support two different ways to display the 
  195.     contents of a directory room's directory.  The first is the old
  196.     way, and will remain the same -- .R(ead) D(irectory).  The second
  197.     method is used to display the file descriptions, and is .R(ead)
  198.     <E(xtended directory).  
  199.  
  200.     The format of a directory listing using .RE is like this:  
  201.  
  202.         fn1      f1size | f1 description (date created)
  203.         fn2      f2size | f2 description (date created)
  204.           .
  205.           .
  206.           .
  207.         fnx      fxsize | fx description (date created)
  208.  
  209.  
  210.     The fnX is filename x, and fXsize is the size of that file in 
  211.     xmodem sectors.  The output is, of course, formatted to the users 
  212.     screen, so people with screens <= 40 are going find these listings
  213.     a little hard to follow...  
  214.  
  215.     So, how do we put these descriptions in, you ask?  (I should let 
  216.     you folk guess!) For each directory room that you want to have 
  217.     descriptions for the files, there must be a file named `$DIR'
  218.     (`.DIR' on the Atari ST.) Within this file will be the
  219.     descriptions, formatted in the following way:  
  220.  
  221.         fn1<tab>f1 description
  222.         fn2<tab>f2 description
  223.           .
  224.           .
  225.           .
  226.         fnX<tab>fX description
  227.  
  228.     Each fnX is the filename, in the left most column of the screen.  
  229.     "fX description" is the description for that file.  It is limited
  230.     to one* line for each file.  However, that line may extend up to
  231.     7000 characters, so if you have a text editor that will handle
  232.     7000 characters on one line, and really want to do that to your
  233.     users...  Between each fnX and its description there must be at
  234.     least* one tab.  
  235.  
  236.     Each filename must be in uppercase, and the filenames must be in 
  237.     alphabetical order for .RE to work properly.  STadel puts new file
  238.     descriptions into the $DIR file in the proper order when somebody 
  239.     uploads a file to the system.  
  240.  
  241.  
  242. 5) OPERATING HINTS
  243.  
  244.     Citadel systems haven't had great reliability problems to date, 
  245.     but reasonably regular backups aren't a bad idea anyhow.  An 
  246.     incremental archive program is contemplated.  
  247.  
  248.     Message files can be expanded via use of EXPAND.TOS;  see
  249.     UTIL.DOC.  Still, it's a good idea to start with a big system and
  250.     not screw around with it too much.  
  251.  
  252.     There's nothing compiled into the system concerning the number or
  253.     structure of .HLP files.  The system just looks for a ".HLP" file 
  254.     with the requested name, and prints it.  Feel free to edit
  255.     existing help files and add new ones as typical points of
  256.     confusion become clear.  Helpfiles may also be put in directory
  257.     rooms, of course.  A local-BBs listing probably makes more sense
  258.     as a .HLP file;  segmenting the local-BBs help file into several
  259.     files is another thought if there are a large number of local
  260.     BBSs.  
  261.  
  262.     If you want mail to Sysop to go to your account, there is a 
  263.     variable in ctdlcnfg.sys that you can set to send it there -
  264.     #sysop "person" will send all sysop mail to person.  On Pell, it
  265.     is set up as #sysop "orc" to send all sysop mail to me.  
  266.  
  267. 5.1) Pointlets
  268.  
  269.     o The system does a 20-sec wait on bad passwords, to discourage 
  270.     password guessing.  If you're establishing a new account, use a 
  271.     single-letter pw on first password prompt, and you can bypass
  272.     this.  
  273.  
  274.     o The system converts messages from uppercase-only folks to 
  275.     lowercase, then does a simple capitalization algorithm.  This is 
  276.     lots easier on the eyes, but will confuse someone sooner or later.
  277.  
  278.     o There are also several utilities for use with the system.  See 
  279.     UTIL.DOC.  
  280.  
  281.     o There are several options you can give STadel on the command
  282.     line to vary its behavior;  `+hup' will leave the phone active
  283.     when you exit STadel and when you ESC to console mode, `+netlog'
  284.     will keep a log of all network activities in the file NETLOG.SYS
  285.     in your audit directory, `+netdebug' turns network debugging on,
  286.     `+ymodem' will make the default extended networking protocol
  287.     ymodem (the normal default is wxmodem), and `+line' (on ST's only)
  288.     puts a status line at the bottom of the screen.  
  289.  
  290.  
  291. 6) WHERE THE VARIOUS STADEL FILES GO
  292.  
  293.     #sysdir    CTDLLOG.SYS CTDLROOM.SYS CTDLDOOR.SYS CTDLFLR.SYS CTDLARCH.SYS
  294.     #msgdir    CTDLMSG.SYS
  295.     #netdir    CTDLNET.SYS ALIAS.SYS UUCP.INI UUCP.SYS <Network workfiles>
  296.     #helpdir    <All the help, menu, and blurb files>
  297.     #auditdir    CHAT.REC CALLLOG.SYS NETLOG.SYS FILELOG.SYS SYSOP.MSG
  298.     #receiptdir    <All files gotten from the network>
  299.     #mirrordir    CTDLMSG.SYS (backup)
  300.  
  301.  
  302. 7) CITADEL IN A SHELLSCRIPT
  303.  
  304.     No program is ever bug-free.  However, it is nice to pretend that 
  305.     one is, and an effective way to pretend that a particular program 
  306.     has achieved such a goal is by never having it require your 
  307.     attention when you are attending to other things.  
  308.  
  309.     STadel tries to emulate this sort of software by returning a 
  310.     value to the operating system when it terminates gracefully.  
  311.     There are 3 possible values returned by STadel that can be read by
  312.     a batch file (provided, of course, that you are using a batch
  313.     processor that can handle it):  
  314.  
  315.     0)  indicates that the sysop requested that the program terminate.
  316.     2)  indicates ABNORMAL termination, i.e., the system had an error
  317.     of some sort and has crashed gracefully.
  318.     3)  indicates that a Remote sysop has taken the system down via
  319.     Remote sysop capabilities.
  320.  
  321.     Furthermore, STadel, when called with ANY argument(s) on the 
  322.     command line, will leave message in the Aide> room notifying the 
  323.     aides that the system came up at the time specified in the message
  324.     header.  The argument itself doesn't matter;  it's presence on the
  325.     command line is the important part.  
  326.  
  327.     And, plus, when Configur is called with any argument(s) (just 
  328.     like Citadel, above), it will assume that it is in unattended
  329.     mode, and will not ask the sysop if he wants to erase the files;
  330.     it will assume that since the sysop is not around, he wants to
  331.     preserve his data files, and just scans the files.  
  332.  
  333.     What can you do with the above?  Here is the batch file I use for
  334.     running STadel with the teeny-shell (my own shell....) 
  335.  
  336.     >  #
  337.     >  # Fire pell up and let it fly...
  338.     >  #
  339.     >  here=$cwd
  340.     >  cd f:/
  341.     >  while [ "$status" !~ exit ]
  342.     >      if [ ! -e ctdltabl.sys ]
  343.     >          configur x
  344.     >          status=$? crash=kablooey
  345.     >          if [ $status !~ 0 ] ; status=exit; fi
  346.     >      else
  347.     >          status=0
  348.     >      fi
  349.     >      if [ $status ~ 0 ]
  350.     >          citadel +netlog $crash
  351.     >          status=$?
  352.     >          # echo citadel returns status = $status
  353.     >          if [ $status ~ 1 ] ; cp -f *.sys backup; fi   # timeout
  354.     >          if [ $status ~ 0 ] ; status=exit       ; fi   # sysop exit
  355.     >          if [ $status ~ 3 ] ; status=exit       ; fi   # remote exit
  356.     >          if [ $status ~ 10 ]; uucall            ; fi   # uucp event
  357.     >      fi
  358.     >      unset crash
  359.     >  done
  360.     >  unset status        # in case we sourc'ed this file....
  361.     >  cd $here
  362.  
  363.  
  364.     And here is an example of a MS-DOS command.com batch file that
  365.     does essentially the same thing:  
  366.  
  367.     > echo off
  368.     >
  369.     > :reset
  370.     > configur +
  371.     > if errorlevel goto byeo
  372.     > goto loop
  373.     >
  374.     > :loop
  375.     > citadel +ymodem
  376.     > if errorlevel 20 goto popular
  377.     > if errorlevel 6 goto callbix
  378.     > if errorlevel 3 goto loop
  379.     > if errorlevel 3 goto timeout
  380.     > goto byeo
  381.     >
  382.     > :popular
  383.     > tm >> timelog
  384.     > echo popular >> timelog
  385.     > popular -msb > c:\hfh\library\popular
  386.     > netmap -p    > c:\hfh\library\netmap
  387.     > callstat -s -u
  388.     > goto loop
  389.     >
  390.     > :callbix
  391.     > tm >> timelog
  392.     > echo callbix >> timelog
  393.     > bixcall -x
  394.     > goto loop
  395.     >
  396.     > :calluucp
  397.     > tm >> timelog
  398.     > echo calluucp >> timelog
  399.     > uucall -suucp -x
  400.     > goto loop
  401.     >
  402.     > :timeout
  403.     > tm >> timelog
  404.     > echo timeout >> timelog
  405.     >
  406.     > :byeo
  407.  
  408.  
  409. 8) AUDITING THE USERS
  410.  
  411.     STadel isn't really set up to be properly paranoid about users,
  412.     but it makes a few attempts to track user activity.  If you want,
  413.     you can log user logins/logouts, file download activity (file
  414.     uploads are already logged as messages in the room that the files
  415.     are uploaded into), and, with the use of some external programs,
  416.     make up reams of silly data on call frequency, etc.  
  417.  
  418.     The simplest form of auditing is the call-log.  If you #define
  419.     CALL-LOG (in ctdlcnfg.sys) as nonzero, STadel will create the file
  420.     calllog.sys in your auditdir.  This file consists of records of
  421.     the following form:  
  422.  
  423.     System brought up 88Oct29 @ 22:31
  424.     orc                 : 88Oct29 22:38 - 22:39 (console)   P  
  425.     fred q. pirate      : 88Oct29 22:58 - 22:59 (1200)    + -    
  426.     sam the novice      : 88Oct29 23:12 - 23:50 (2400)    + 
  427.     System brought down 88Oct29 @ 22:59
  428.  
  429.     These either tell you that the system was brought up or down at a
  430.     certain time, or the times that a user was on the system, what
  431.     baudrate s/he was calling the system at (`(console) is, of course,
  432.     someone at the system console), whether or not s/he was a new
  433.     user, and how s/he exited the system.  The funny letters at the
  434.     end of a line tell the story;  here they are:  
  435.  
  436.    ` ' - .terminate quit 
  437.    `a' - .terminate punt 
  438.    `-' - .terminate stay 
  439.    `g' - Console user kicked off when carrier was detected. (this
  440.      happens if you're on console and you ^Lm instead of .tq) 
  441.    `d' - Lost carrier. 
  442.    `p' - Punted by preemptive event and/or network mode. 
  443.    `E' - punted because of excessive line noise. 
  444.    `t' - Timed out. 
  445.    `P' - Punted by network polling (^LNP or ^Lm on a console user.) 
  446.    `k' - User killed by ^Lk
  447.    `+' - New user.
  448.  
  449.     You can further customise the auditing by using other commands in 
  450.     ctdlcnfg.sys;  
  451.  
  452.     If you #define FILE-LOG, STadel will keep track of all files
  453.     downloaded from your system in the file filelog.sys in your
  454.     #auditdir.  The information it keeps in that file is the user who
  455.     downloaded, what time s/he started downloading it, the room, and
  456.     the file that was grabbed.  
  457.  
  458.     If you don't want as much info in calllog.sys, you can tell
  459.     citadel to either log calls or system exits by #defining
  460.     AUDIT-CALLS or AUDIT-EXITS.  
  461.